/**
 * @(#)CRUDActionSupport.java
 * Copyright (C) 2003-2010 iocn.org All rights reserved
 */
package org.iocn.core.web.struts2;

import com.opensymphony.xwork2.Preparable;


/**
 * Struts2中典型CRUD Action的抽象基类.
 * 
 * 主要定义了对Preparable,ModelDriven接口的使用,以及CRUD函数和返回值的命名.
 * 
 * @author <b>Oxidy</b>, Copyright &#169; 2010
 * @version 0.1,2010-6-7
 */
public abstract class CRUDActionSupport extends BaseSupportAction implements Preparable {
    private static final long serialVersionUID = -847431863439905744L;

    /**
     * Action函数, 默认的action函数, 默认调用list()函数.
     */
    @Override
    public String execute() throws Exception {
        return list();
    }
    // ---------- CRUD Action函数 ----------//
    /**
     * Action函数,显示Entity列表界面. 建议return SUCCESS.
     */
    public abstract String list() throws Exception;
    /**
     * Action函数,显示新增或修改Entity界面. 建议return INPUT.
     */
    @Override
    public abstract String input() throws Exception;
    /**
     * Entity详细页面.建议return detail
     */
    public abstract String detail() throws Exception;
    /**
     * Action函数,新增或修改Entity. 建议return RELOAD.
     */
    public abstract String save() throws Exception;
    /**
     * Action函数,删除Entity. 建议return RELOAD.
     */
    public abstract String delete() throws Exception;
    // ---------- Preparable函数 ----------//
    /**
     * 实现空的prepare()函数,屏蔽所有Action函数公共的二次绑定.
     */
    public void prepare() throws Exception {
    }
    /**
     * 在input()前执行二次绑定.
     */
    public void prepareInput() throws Exception {
        prepareModel();
    }
    /**
     * 在save()前执行二次绑定.
     */
    public void prepareSave() throws Exception {
        prepareModel();
    }
    /**
     * 等同于prepare()的内部函数,供prepardMethodName()函数调用.
     */
    protected abstract void prepareModel() throws Exception;
}
